/*
 * Copyright 2008-2009 Daniel Freitas
 * 
 * This file is part of Army Creator.
 * 
 * Army Creator is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * Army Creator is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with Army Creator. If not, see
 * <http://www.gnu.org/licenses/>.
 */
package com.googlecode.armycreator.datastore.genericdao;

import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

/**
 * A DAO query executor is responsible to run queries based on the method called in the target DAO interface.
 * Implementing classes are responsible to define the semantics of how the query gets to be executed.
 * 
 * @author <a href="mailto:daniel.mfreitas@gmail.com">Daniel Freitas</a>
 */
public interface DaoQueryExecutor {

    /**
     * Executes a query for the method in the specified DAO interface.
     * 
     * @param queryMethodInvocation
     *            Information about the invoked method.
     * 
     * @return The result generated by the method invocation.
     * 
     * @throws DataPersistenceException
     *             If there's an error while trying to execute the query.
     */
    @Transactional(propagation = Propagation.REQUIRED)
    public Object executeQueryForMethod(QueryMethodInvocation queryMethodInvocation) throws DataPersistenceException;
}
